com.inscoper.api.Status¶

Status class represents a state of the system. More...

Public Functions¶

	Name
synchronized void	delete()
void	addParam(SubDeviceId subDeviceId, Object value)
void	addMultiParam(SubDeviceId subDeviceId, int tag, Object value)
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, Object value)
Object	getValue(SubDeviceId subDeviceId)
boolean	equals(Object obj)
int	hashCode()
	Status() Default constructor.
	Status(StatusParamVector statusParams, StringVector tags) Constructor with parameters and tags.
	Status(Status status, boolean copy) Copy constructor.
	Status(Status status) Copy constructor.
void	fromXML(XMLNode xml) Load from XML.
void	toXML(XMLNode xmlParent) Save to XML.
void	setStatus(Status status, boolean copy) Update status content.
void	setStatus(Status status) Update status content.
StatusParamVector	getParamList() Get the status parameter list.
StatusParam	getParam(SubDeviceId subDeviceId) Get the status parameter by sub-device ID.
boolean	hasParamValue(SubDeviceId subDeviceId) Check if the status parameter has a value.
String	getParamStringValue(SubDeviceId subDeviceId) Get string value.
char	getParamCharValue(SubDeviceId subDeviceId) Get char value.
short	getParamShortValue(SubDeviceId subDeviceId) Get short value.
int	getParamIntValue(SubDeviceId subDeviceId) Get int value.
java.math.BigInteger	getParamUnsignedLongValue(SubDeviceId subDeviceId) Get unsigned long long value.
long	getParamLongValue(SubDeviceId subDeviceId) Get long long value.
float	getParamFloatValue(SubDeviceId subDeviceId) Get float value.
double	getParamDoubleValue(SubDeviceId subDeviceId) Get double value.
EParamType	getValueType(SubDeviceId subDeviceId) Get value type.
StringVector	getTags() Get tag list.
void	addTag(String tag) Add a tag.
void	addTags(StringVector tagList) Add multiple tags.
void	addParam(SubDeviceId subDeviceId) Add status parameter without value.
void	addParam(SubDeviceId subDeviceId, String value) Add string status parameter.
void	addParam(SubDeviceId subDeviceId, char value) Add char status parameter.
void	addParam(SubDeviceId subDeviceId, short value) Add short status parameter.
void	addParam(SubDeviceId subDeviceId, int value) Add int status parameter.
void	addParam(SubDeviceId subDeviceId, java.math.BigInteger value) Add unsigned long long status parameter.
void	addParam(SubDeviceId subDeviceId, long value) Add long long status parameter.
void	addParam(SubDeviceId subDeviceId, float value) Add float status parameter.
void	addParam(SubDeviceId subDeviceId, double value) Add double status parameter.
void	addParam(SubDeviceId subDeviceId, boolean value) Add boolean status parameter.
void	addParam(StatusParam newParam) Add existing status parameter.
void	addMultiParam(SubDeviceId subDeviceId, int tag, String value) Add tagged string status parameter.
void	addMultiParam(SubDeviceId subDeviceId, int tag, char value) Add tagged char status parameter.
void	addMultiParam(SubDeviceId subDeviceId, int tag, short value) Add tagged short status parameter.
void	addMultiParam(SubDeviceId subDeviceId, int tag, int value) Add tagged int status parameter.
void	addMultiParam(SubDeviceId subDeviceId, int tag, java.math.BigInteger value) Add tagged unsigned long long status parameter.
void	addMultiParam(SubDeviceId subDeviceId, int tag, long value) Add tagged long long status parameter.
void	addMultiParam(SubDeviceId subDeviceId, int tag, float value) Add tagged float status parameter.
void	addMultiParam(SubDeviceId subDeviceId, int tag, double value) Add tagged double status parameter.
void	addMultiParam(SubDeviceId subDeviceId, int tag, boolean value) Add tagged boolean status parameter.
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, String value) Add indexed tagged string status parameter.
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, char value) Add indexed tagged char status parameter.
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, short value) Add indexed tagged short status parameter.
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, int value) Add indexed tagged int status parameter.
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, java.math.BigInteger value) Add indexed tagged unsigned long long status parameter.
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, long value) Add indexed tagged long long status parameter.
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, float value) Add indexed tagged float status parameter.
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, double value) Add indexed tagged double status parameter.
void	addMultiParam(int index, SubDeviceId subDeviceId, int tag, boolean value) Add indexed tagged boolean status parameter.
boolean	containsParam(SubDeviceId subDeviceId) Check if status parameter exists.
void	removeParam(SubDeviceId subDeviceId) Remove status parameter.

Protected Functions¶

	Name
	Status(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Status obj)

Detailed Description¶

public class com.inscoper.api.Status;

Status class represents a state of the system.

A Status object encapsulates the state of the microscope and other devices at a particular moment. It manages a list of status parameters, which are key-value pairs associating a sub-device with a value. It also maintains a list of tags used for sequence generation with recipes.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    Object value
)

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    Object value
)

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    Object value
)

function getValue¶

public Object getValue(
    SubDeviceId subDeviceId
)

function equals¶

public boolean equals(
    Object obj
)

function hashCode¶

public int hashCode()

function Status¶

public Status()

Default constructor.

Initializes a new instance of the Status class.

function Status¶

public Status(
    StatusParamVector statusParams,
    StringVector tags
)

Constructor with parameters and tags.

Parameters:

statusParams : The list of status parameter objects
tags : The list of tags

Initializes a new instance of the Status class with a list of parameters and tags.

function Status¶

public Status(
    Status status,
    boolean copy
)

Copy constructor.

Parameters:

status : The source Status object
copy : If true, performs a deep copy, otherwise status parameters are shared with the source (default: false)

Exceptions:

InscoperException If an error occurs during copy

Creates a new instance of the Status class from an existing one, optionally performing a deep copy.

function Status¶

public Status(
    Status status
)

Copy constructor.

Parameters:

status : The source Status object

Exceptions:

InscoperException If an error occurs during copy

Creates a new instance of the Status class from an existing one, optionally performing a deep copy.

function fromXML¶

public void fromXML(
    XMLNode xml
)

Load from XML.

Parameters:

xml : The XML node containing status information

Exceptions:

InscoperException If an error occurs

Populates the status information from an XML node.

function toXML¶

public void toXML(
    XMLNode xmlParent
)

Save to XML.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurs

Exports the status information to an XML node attached to the parent node.

function setStatus¶

public void setStatus(
    Status status,
    boolean copy
)

Update status content.

Parameters:

status : The source status
copy : If true, performs a deep copy, otherwise status parameters are shared with the source (default: false)

Exceptions:

InscoperException If an error occurs

Updates this status with the content of another status.

function setStatus¶

public void setStatus(
    Status status
)

Update status content.

Parameters:

status : The source status

Exceptions:

InscoperException If an error occurs

Updates this status with the content of another status.

function getParamList¶

public StatusParamVector getParamList()

Get the status parameter list.

Return: The list of status parameters

Retrieves the list of all status parameters in this status.

function getParam¶

public StatusParam getParam(
    SubDeviceId subDeviceId
)

Get the status parameter by sub-device ID.

Parameters:

subDeviceId : The sub-device ID of the desired parameter

Return: The status parameter, or null if not found

Retrieves a specific status parameters associated with the given sub-device ID.

function hasParamValue¶

public boolean hasParamValue(
    SubDeviceId subDeviceId
)

Check if the status parameter has a value.

Parameters:

subDeviceId : The sub-device ID to check

Exceptions:

InscoperException If an error occurs

Return: True if the parameter has a value, false otherwise

Checks if the status parameter associated with the given sub-device ID exists and has at least a value assigned.

function getParamStringValue¶

public String getParamStringValue(
    SubDeviceId subDeviceId
)

Get string value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The string value

Retrieves the value of the status parameter associated with the sub-device ID as a string.

function getParamCharValue¶

public char getParamCharValue(
    SubDeviceId subDeviceId
)

Get char value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The char value

Retrieves the value of the status parameter associated with the sub-device ID as a char.

function getParamShortValue¶

public short getParamShortValue(
    SubDeviceId subDeviceId
)

Get short value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The short value

Retrieves the value of the status parameter associated with the sub-device ID as a short.

function getParamIntValue¶

public int getParamIntValue(
    SubDeviceId subDeviceId
)

Get int value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The int value

Retrieves the value of the status parameter associated with the sub-device ID as an int.

function getParamUnsignedLongValue¶

public java.math.BigInteger getParamUnsignedLongValue(
    SubDeviceId subDeviceId
)

Get unsigned long long value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The unsigned long long value

Retrieves the value of the status parameter associated with the sub-device ID as an unsigned long long.

function getParamLongValue¶

public long getParamLongValue(
    SubDeviceId subDeviceId
)

Get long long value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The long long value

Retrieves the value of the status parameter associated with the sub-device ID as a long long.

function getParamFloatValue¶

public float getParamFloatValue(
    SubDeviceId subDeviceId
)

Get float value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The float value

Retrieves the value of the status parameter associated with the sub-device ID as a float.

function getParamDoubleValue¶

public double getParamDoubleValue(
    SubDeviceId subDeviceId
)

Get double value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The double value

Retrieves the value of the status parameter associated with the sub-device ID as a double.

function getValueType¶

public EParamType getValueType(
    SubDeviceId subDeviceId
)

Get value type.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or type cannot be determined

Return: The parameter type of the value

Retrieves the type of the value for the status parameter associated with the sub-device ID.

function getTags¶

public StringVector getTags()

Get tag list.

Return: The list of tags

Retrieves the list of tags associated with this status.

function addTag¶

public void addTag(
    String tag
)

Add a tag.

Parameters:

tag : The tag to add

Adds a single tag to the status.

function addTags¶

public void addTags(
    StringVector tagList
)

Add multiple tags.

Parameters:

tagList : The list of tag

Adds a list of tags to the status.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId
)

Add status parameter without value.

Parameters:

subDeviceId : The sub-device ID for the new parameter

Exceptions:

InscoperException If an error occurs

Adds a status parameter for the given sub-device ID without assigning a value.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    String value
)

Add string status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The string value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a string value.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    char value
)

Add char status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The char value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a char value.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    short value
)

Add short status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The short value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a short value.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    int value
)

Add int status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The int value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with an int value.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    java.math.BigInteger value
)

Add unsigned long long status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The unsigned long long value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with an unsigned long long value.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    long value
)

Add long long status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The long long value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a long long value.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    float value
)

Add float status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The float value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a float value.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    double value
)

Add double status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The double value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a double value.

function addParam¶

public void addParam(
    SubDeviceId subDeviceId,
    boolean value
)

Add boolean status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The boolean value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a boolean value.

function addParam¶

public void addParam(
    StatusParam newParam
)

Add existing status parameter.

Parameters:

newParam : The status parameter to add

Exceptions:

InscoperException If an error occurs

Adds an existing status parameter to the status.

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    String value
)

Add tagged string status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The string value

Exceptions:

InscoperException If an error occurs

Adds a tagged status parameter with a string value.

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    char value
)

Add tagged char status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The optimization tag
value : The char value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    short value
)

Add tagged short status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The short value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    int value
)

Add tagged int status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The int value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    java.math.BigInteger value
)

Add tagged unsigned long long status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned long long value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    long value
)

Add tagged long long status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The long long value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    float value
)

Add tagged float status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The float value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    double value
)

Add tagged double status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The double value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    SubDeviceId subDeviceId,
    int tag,
    boolean value
)

Add tagged boolean status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The boolean value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    String value
)

Add indexed tagged string status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The string value

Exceptions:

InscoperException If an error occurs

Adds a parameter with index, tag, and string value.

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    char value
)

Add indexed tagged char status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The char value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    short value
)

Add indexed tagged short status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The short value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    int value
)

Add indexed tagged int status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The int value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    java.math.BigInteger value
)

Add indexed tagged unsigned long long status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned long long value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    long value
)

Add indexed tagged long long status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The long long value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    float value
)

Add indexed tagged float status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The float value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    double value
)

Add indexed tagged double status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The double value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

public void addMultiParam(
    int index,
    SubDeviceId subDeviceId,
    int tag,
    boolean value
)

Add indexed tagged boolean status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The boolean value

Exceptions:

InscoperException If an error occurs

function containsParam¶

public boolean containsParam(
    SubDeviceId subDeviceId
)

Check if status parameter exists.

Parameters:

subDeviceId : The sub-device ID to check

Return: True if the parameter exists, false otherwise

Verifies if a status parameter with the given sub-device ID exists in the status.

function removeParam¶

public void removeParam(
    SubDeviceId subDeviceId
)

Remove status parameter.

Parameters:

subDeviceId : The sub-device ID of the parameter to remove

Removes the status parameter identified by the sub-device ID from the status.

Protected Functions Documentation¶

function Status¶

protected Status(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    Status obj
)

Updated on 2026-04-02 at 10:55:38 +0200